Получить информацию о предстоящей поездке
Запрос позволяет узнать предварительную стоимость поездки для разных тарифов и создать оффер на поездку.
Синтаксис запроса
POST https://business.taxi.yandex.ru/api/1.0/estimate
🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.
Заголовки запроса:
Authorization
OAuth-токен. Процесс получения токена описан в разделе Начало работы.
Данные о заказе передаются в теле запроса в формате JSON:
|
Поле |
Описание |
Формат |
|
|
Блок информации о маршруте поездки. Координаты поездки указываются в следующием формате: Обязательное поле. |
Массив |
|
|
Список требований к поездке. Может варьироваться в зависимости от города. Чтобы узнать поддерживаемые требования, отправьте пустой объект |
Объект |
|
|
Телефонный номер для связи с пассажиром. |
Строка |
Описание полей ответа
В ответе могут содержаться следующие поля:
| Поле | Описание | Формат |
|---|---|---|
currency_rules |
Блок с информацией о валюте. | Объект |
code |
Код валюты. | Строка |
sign |
Символ валюты. | Строка |
template |
Шаблон для комментария с ценой. | Строка |
text |
Текстовое описание валюты. | Строка |
is_fixed_price |
Признак факсированной цены. Возможные значения: - true — фиксированная цена.- false — динамическая цена. |
Логическое |
service_levels |
Блок с данными о поездке для разных тарифах. Блок каждого тарифа содержит следующие поля: - name; - price; - price_raw; - details_tariff. |
Массив объектов |
name |
Название тарифа. | Строка |
price |
Текстовое описание цены поездки. | Строка |
price_raw |
Числовое описание цены поездки. | Число |
details_tariff |
Пояснение к тарифу. | Массив объектов |
type |
Тип пояснения. Возможные значения: - price — минимальная цена поездки.- camment — текстовый комментарий к тарифу. |
Строка |
value |
Значение пояснения. | Строка |
fare_disclaimer |
Пояснение к сформированной цене. | Строка |
offer |
Оффер поездки. Используйте данное поле, чтобы создать черновик заказа с ценой поездки, указанной в поле price. Оффер с текущей ценой действует ограниченное время. Если время жизни оффера истеко, ответ на запрос Обработка заказа будет содержать код ошибки 406. Если в запросе не указано поле phone, сервис не создаст оффер, но рассчитает цену поездки. |
Строка |
Пример запроса
POST https://business.taxi.yandex.ru/api/1.0/estimate
...
Authorization: <OAuth-токен>
{
"route": [
[
37.622504,
55.753215
],
[
37.635813,
55.839525
]
],
"requirements": {
"nosmoking": true,
"conditioner": true
},
"phone": "+71234567890",
"selected_class": "econom"
}
Пример ответа
Пример ответа на данный запрос выглядит следующим образом:
{
"currency_rules": {
"code": "RUB",
"sign": "₽",
"template": "$VALUE$ $SIGN$$CURRENCY$",
"text": "rub"
},
"is_fixed_price": true,
"service_levels": [
{
"class": "econom",
"price": "460 руб.",
"price_raw": "460",
"details_tariff": [
{
"type": "price",
"value": "от 99 руб."
},
{
"type": "comment",
"value": "включено 4 мин., далее 9 руб./мин."
},
{
"type": "comment",
"value": "включено 2 км, далее 9 руб./км"
}
],
"fare_disclaimer": "increased demand"
},
...
],
"offer": "1bfc6ef0377607d98deb6b91ab90ef2f"
}
Возможные коды ответа
Ответ на данный запрос может содержать следующие стандартные HTTP-коды:
200— запрос выполнен успешно.400— в запросе был передан неизвестный параметр или параметр с
недопустимым значением.401— был передан неверный OAuth-токен.